Skip to content

Commit

Permalink
readme: add nix flake instructions
Browse files Browse the repository at this point in the history
  • Loading branch information
Yohh committed Mar 6, 2025
1 parent a859bc0 commit d7a2525
Showing 1 changed file with 19 additions and 8 deletions.
27 changes: 19 additions & 8 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -9,7 +9,6 @@ Netzgrafik-Editor – designed to make better decisions.
The product vision is to accelerate the planning and sizing of transport systems by creating an intuitive and powerful platform that uses smart projections and analyses. This will enable timetable variations or service options to be created, compared, and optimized very easily, with maximum support for the human planner during their creative process. The goal is to ensure that decisions can be made based on data-driven insights, to guarantee a smooth mobility for the future that is fast, efficient, and goal-oriented.
<br><br>

>
> **Flexible level of detail** - start with a rough sketch, continuously add more detail.
>
> Applicable across **different industries** - bus, train, plane.
Expand All @@ -22,7 +21,6 @@ The product vision is to accelerate the planning and sizing of transport systems
>
> **Excellent and intuitive UX** - using Netzgrafik-Editor should be as easy and natural as drawing
> on a whiteboard. No training required. Analysis happens in real time.
>
</details>

Expand All @@ -38,7 +36,6 @@ Regular-interval timetable

<br>

>
> Regular-interval timetables were first developed in Germany at the beginning of the 20th century
> to coordinate urban traffic in large cities such as Berlin.
>
Expand All @@ -54,13 +51,10 @@ Regular-interval timetable
>
> [clock-faced schedules](https://en.wikipedia.org/wiki/Clock-face_scheduling)
>
>
> [Source](https://www.swissinfo.ch/eng/to-the-second_the-swiss-timetable-is-due-to-meticulous-planning/34102496)
>
</details>


![Netzgrafik-Editor](./documentation/images/Overview_Editor_Screenshot_001.PNG)

It offers various functions to enhance the efficiency and optimization of the logistics network.
Expand Down Expand Up @@ -142,7 +136,8 @@ The openness of the project encourages innovation, expertise from different sect
improvements to optimize the
planning processes.

## Roadmap
## Roadmap

Get an insight into the plan and future [ROADMAP.md](ROADMAP.md).

## User Manual
Expand Down Expand Up @@ -204,6 +199,23 @@ docker compose up
>
> Login with username **user** and password **user**
#### For Nix Package Manager users

Nix users can use the `flake.nix` file to setup a development environment.

To use the flake, the Nix experimental features `nix-command` and `flakes` are required.

See [official Nix documentation](https://nixos.wiki/wiki/Flakes) for more information.

Combined with the `direnv` tool, the following commands can be used to setup the development environment each time the project folder is entered:

```shell
# allow direnv to use the flake
echo \"use flake\" >> .envrc && direnv allow
```

See [official direnv documentation](https://direnv.net/) for more information.

### Testing

```
Expand Down Expand Up @@ -256,7 +268,6 @@ Open-source projects thrive on collaboration and contributions from the communit
contributors are requested to read the [CONTRIBUTING.md](CONTRIBUTING.md) file as it outlines how to
contribute to the project, including how to submit bug reports, feature requests, and pull requests.


## Coding Standards

All contributors are requested to read the [CODING_STANDARDS.md](CODING_STANDARDS.md) file that
Expand Down

0 comments on commit d7a2525

Please sign in to comment.