Skip to content

Commit e90ec63

Browse files
committed
Update README
1 parent a8d54a8 commit e90ec63

File tree

2 files changed

+19
-15
lines changed

2 files changed

+19
-15
lines changed

NEWS.md

Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,9 @@
1+
## v0.1.1.9000 (development version)
2+
3+
## v0.1.0 (2026-01-28)
4+
5+
First release! 🎉
6+
17
## v0.0.0.9000 (development version)
28

39
- Added a `NEWS.md` file to track changes to the package.

README.md

Lines changed: 13 additions & 15 deletions
Original file line numberDiff line numberDiff line change
@@ -2,14 +2,14 @@
22

33
<!-- badges: start -->
44
[![Project Status: Active – The project has reached a stable, usable state and is being actively developed.](https://www.repostatus.org/badges/latest/active.svg)](https://www.repostatus.org/#active)
5-
[![build-flatpak.yaml](https://github.com/danielvartan/logopak/actions/workflows/build-flatpak.yaml/badge.svg)](https://github.com/danielvartan/logopak/actions/workflows/build-flatpak.yaml)
5+
[![build-flatpak.yaml](https://github.com/danielvartan/logopak/actions/workflows/build-flatpack.yaml/badge.svg)](https://github.com/danielvartan/logopak/actions/workflows/build-flatpack.yaml)
66
[![GPLv3 License Badge](https://img.shields.io/badge/license-GPLv3-bd0000.png)](https://www.gnu.org/licenses/gpl-3.0)
77
[![Contributor Covenant 3.0 Code of Conduct](https://img.shields.io/badge/Contributor%20Covenant-3.0-4baaaa.svg)](https://www.contributor-covenant.org/version/3/0/code_of_conduct/)
88
<!-- badges: end -->
99

1010
`LogoPak` is a [Flatpak](https://flatpak.org/) package for [NetLogo](https://ccl.northwestern.edu/netlogo/), a multi-agent programmable modeling environment for simulating natural and social phenomena. It simplifies the installation and management of NetLogo on Linux systems.
1111

12-
The package includes all four NetLogo applications (NetLogo, NetLogo 3D, HubNet Client, and Behaviorsearch) and registers desktop files, file icons, and MIME types for NetLogo model files, enabling users to use NetLogo like any other native application on their system.
12+
The package includes all four NetLogo applications (NetLogo, NetLogo 3D, HubNet Client, and BehaviorSearch) and registers desktop files, file icons, and MIME types for NetLogo model files, enabling users to use NetLogo like any other native application on their system.
1313

1414
![](images/showcase.png)
1515

@@ -21,6 +21,8 @@ The package includes all four NetLogo applications (NetLogo, NetLogo 3D, HubNet
2121

2222
`LogoPak` is not yet available on [Flathub](https://flathub.org/). To install it, you can download and install the pre-built bundle or build it locally from source. This assumes you have [Flatpak](https://flatpak.org/) installed on your system.
2323

24+
The current version of NetLogo included in `LogoPak` is **NetLogo 7.0.3**.
25+
2426
### Using the Pre-built Bundle
2527

2628
The easiest way to install `LogoPak` is by using the pre-built Flatpak bundle:
@@ -29,13 +31,18 @@ The easiest way to install `LogoPak` is by using the pre-built Flatpak bundle:
2931
2. Install the bundle by running the following command in your terminal:
3032

3133
```bash
32-
flatpak install --user path/to/netlogo.flatpak
34+
flatpak install --user netlogo.flatpak
3335
```
3436

35-
3637
### Building from Source
3738

38-
To build `LogoPak` from source, you'll need [Flatpak](https://flatpak.org/) and [`flatpak-builder`](https://docs.flatpak.org/en/latest/flatpak-builder.html) on your system. Here's how to get them using your distribution's package manager:
39+
To build `LogoPak` from source, start by cloning this repository:
40+
41+
```bash
42+
git clone https://github.com/danielvartan/logopak
43+
```
44+
45+
You'll need [Flatpak](https://flatpak.org/) and [`flatpak-builder`](https://docs.flatpak.org/en/latest/flatpak-builder.html) on your system. Here's how to get them using your distribution's package manager:
3946

4047
```bash
4148
# On Ubuntu/Debian
@@ -92,15 +99,6 @@ flatpak run --command=HubNetClient com.danielvartan.netlogo
9299
flatpak run --command=Behaviorsearch com.danielvartan.netlogo
93100
```
94101

95-
Or use the lowercase aliases if you prefer:
96-
97-
```bash
98-
flatpak run --command=netlogo com.danielvartan.netlogo
99-
flatpak run --command=netlogo3d com.danielvartan.netlogo
100-
flatpak run --command=hubnetclient com.danielvartan.netlogo
101-
flatpak run --command=behaviorsearch com.danielvartan.netlogo
102-
```
103-
104102
#### Creating a Flatpak Bundle
105103

106104
An easier way to distribute the application is by creating a Flatpak bundle. For that, run the following commands:
@@ -111,7 +109,7 @@ flatpak-builder --repo=repo --force-clean build-dir com.danielvartan.netlogo.yam
111109
flatpak build-bundle repo netlogo.flatpak com.danielvartan.netlogo
112110
```
113111

114-
After creating the `netlogo.flatpak` bundle, you can share it with others. Anyone can then install it with:
112+
After creating the `netlogo.flatpak` bundle, you can share it with others. Anyone can install it with:
115113

116114
```bash
117115
flatpak install netlogo.flatpak

0 commit comments

Comments
 (0)