Add a README and LICENSE file

This commit is contained in:
Paul van Tilburg 2019-06-15 11:33:31 +02:00
parent d88f970107
commit 4082a45d5d
2 changed files with 74 additions and 0 deletions

19
LICENSE Normal file
View File

@ -0,0 +1,19 @@
The MIT License (MIT)
Copyright (c) 2019 Paul van Tilburg
Permission is hereby granted, free of charge, to any person obtaining a copy of
this software and associated documentation files (the "Software"), to deal in
the Software without restriction, including without limitation the rights to
use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of
the Software, and to permit persons to whom the Software is furnished to do so,
subject to the following conditions:
The above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software.
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS
FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR
COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER
IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN
CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

55
README.md Normal file
View File

@ -0,0 +1,55 @@
# Stop Time
A web application for task/project time registration and invoicing.
This application is written in Rust using the Rocket/Diesel and Yew frameworks.
**WORK IN PROGRESS** This application is a rewrite of _Stop… Camping Time!_ and
is still very much work in progress. It will not include the full feature set
of the original application (as described out below) until version 1.0.0 is
reached
## Features
* Running project & tasks overview
* Timeline overview of registered time
* Management customer information
* Administration of running and billed projects/task with
* fixed cost, or
* hourly rates
* Administration of invoices
* Invoice generation in PDF/LaTeX format
* can include a time specification if required by the customer
* Fully responsive (can be used om smartphone, tablet and desktop)
## Requirements
_Stop Time_ is a Rocket/Yew application. To build it you need:
* Rust nightly (≥ 1.31)
* Cargo
To deploy it you also need:
* Diesel CLI (≥ 1.4.2)
Finally, for invoice generated you need the following LaTeX programs:
* pdflatex, with:
* isodoc package (>= 1.00)
* rubber
## Installation
For now, _Stop Time_ is in a developing state and not ready for
site-wide deployment yet. Instructions will follow later.
## Usage
Instructions will be added here later.
## License
_Stop Time_ is free software; you can use, copy, modify, merge, publish,
(re)distribute, sublicense, and/or sell copies of it under the terms of the
MIT License.