lali/README.md

58 lines
1.5 KiB
Markdown
Raw Permalink Normal View History

2024-11-19 16:57:32 +01:00
> [!warning]
> This is a work in progress and not stable.
2024-04-09 18:46:06 +02:00
2024-11-19 16:57:32 +01:00
# Lali
2024-04-09 18:46:06 +02:00
2024-11-26 12:16:41 +01:00
Lali is a simple anime lists manager that stores your lists locally, but with the ability to use online services (e.g AniList) as source.
2024-04-09 18:46:06 +02:00
2024-11-26 12:16:41 +01:00
![Lali](https://codeberg.org/vyn/lali/raw/branch/main/images/lali.png)
*Lali is an acronym for **L**ocal **A**nime **Li**sts*
2024-04-09 18:46:06 +02:00
2024-11-19 16:57:32 +01:00
## Build from source
2024-04-09 18:46:06 +02:00
2024-11-19 16:57:32 +01:00
### Requirements
2024-04-09 18:46:06 +02:00
2024-11-19 16:57:32 +01:00
- GCC >= 14.2.1
- CMake >= 3.30.2
- Ninja (or Make but you will need to adapt the commands)
- Git
2024-04-09 18:46:06 +02:00
2024-11-19 16:57:32 +01:00
### Steps
2024-04-09 18:46:06 +02:00
2024-11-19 16:57:32 +01:00
Fetch and setup the repository:
2024-04-09 18:46:06 +02:00
```
2024-11-19 16:57:32 +01:00
git clone https://codeberg.org/vyn/lali.git
cd lali
git submodule update --init --recursive
2024-04-09 18:46:06 +02:00
```
2024-11-19 16:57:32 +01:00
To build:
2024-04-09 18:46:06 +02:00
```
2024-11-19 16:57:32 +01:00
cmake -DCMAKE_BUILD_TYPE=Release -S . -B ./build -G Ninja
cd build
ninja
2024-04-09 18:46:06 +02:00
```
2024-11-19 16:57:32 +01:00
Then you should have a `lali` executable in the `build` directory you are currently in.
2024-04-09 18:46:06 +02:00
2024-11-19 16:57:32 +01:00
## Contributing
2024-04-09 18:46:06 +02:00
2024-11-19 16:57:32 +01:00
Feel free to make suggestions and report issues, but I do **not** accept contributions (pull requests).
2024-04-09 18:46:06 +02:00
## License
2024-11-19 16:57:32 +01:00
Copyright (C) Vyn 2024
This program is free software: you can redistribute it and/or modify
it under the terms of the GNU General Public License as published by
the Free Software Foundation, under version 3 of the License only.
2024-04-09 18:46:06 +02:00
2024-11-19 16:57:32 +01:00
This program is distributed in the hope that it will be useful,
but WITHOUT ANY WARRANTY; without even the implied warranty of
MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
GNU General Public License for more details.
2024-04-09 18:46:06 +02:00
2024-11-19 16:57:32 +01:00
You should have received a copy of the GNU General Public License
along with this program in the LICENSE file.
If not, see <https://www.gnu.org/licenses/gpl-3.0.txt>.