RenaiApp/README.md

28 lines
745 B
Markdown
Raw Normal View History

2019-07-26 22:18:56 +02:00
![Renai](resources/logo.png 'Renai')
# レンアイ - Hentai Library Thingy
**What?**\
an application for categorizing hentai manga
2019-03-10 20:29:25 +01:00
**Why?**\
see [user stories](workspace/user-stories.md)
**How?**\
Node.js, Electron, Typescript, SQLite3 (TypeORM)
2019-06-23 03:33:48 +02:00
By the way, there is mature content in this repository.
2019-06-23 03:33:48 +02:00
## Development Quickstart
For more information, check [CONTRIBUTING.md](CONTRIBUTING.md).
- `npm install`, the postinstall script compiles native node modules for electron
- might need to install some build tools depending on your platform
- `npm run watch` for code transpilation (starts watchers)
- `npm start`
2019-10-13 01:37:38 +02:00
## Usage
2019-10-13 01:37:38 +02:00
There is nothing to use yet. You might want to contribute a [user story](workspace/user-stories.md) or two.