Skip to content

Commit

Permalink
Edit README. Delete TODO.txt
Browse files Browse the repository at this point in the history
  • Loading branch information
wojciech-graj committed Aug 24, 2022
1 parent 6d2565a commit 395aba5
Show file tree
Hide file tree
Showing 2 changed files with 3 additions and 13 deletions.
8 changes: 3 additions & 5 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -12,7 +12,9 @@ The following packages have to be installed prior to compilation: `gcc pkg-confi
```
apt-get install gcc pkg-config libgtk-3-dev libcglm-dev libcurl4-openssl-dev libepoxy-dev
```
Then to compile, simply:
The makefile automatically checks that the above dependencies are satisfied.

To compile, simply:
```
make
```
Expand All @@ -27,10 +29,6 @@ Windows binaries are provided with github releases. These releases provide the e

To compile for windows, MSYS2 is used. First verify that all required packages are installed by calling `util/wininit.sh`, then compile with `util/winbuild.sh`. This creates the `release` directory containing windows binaries and all other required files.

## Contributing

The program is in a functional state, but it still needs a lot of work to be done on it. A list of things that need to be improved or implemented can be found in the `TODO.txt` file. If you'd want to contribute to the project, please file an issue before commencing any work, since the code will still be undergoing some major changes in the near future.

## License

```
Expand Down
8 changes: 0 additions & 8 deletions TODO.txt

This file was deleted.

0 comments on commit 395aba5

Please sign in to comment.