Added the project description, and moved the license to the end of README.

This commit is contained in:
依瑪貓 2020-09-07 21:53:02 +08:00
parent 267ac952fe
commit 0b4977041e

View File

@ -1,26 +1,25 @@
# mia-accounting
The Mia! Accounting Django Application
The Django Accounting application.
```
Copyright (c) 2020 imacat.
## Description
Licensed under the Apache License, Version 2.0 (the "License");
you may not use this file except in compliance with the License.
You may obtain a copy of the License at
`mia-accounting` is a Django accounting application. It was a re-write of my
own private accounting application written in Perl for `mod_perl` in 2007. The
revision aims to be mobile-friendly with Bootstrap, with a modern back-end
framework and front-end technology like jQuery. The first revision was in
Perl / Mojolicious in 2019. This is the second revision in Python / Django
in 2020.
http://www.apache.org/licenses/LICENSE-2.0
`mia-accounting` comes with two parts:
Unless required by applicable law or agreed to in writing, software
distributed under the License is distributed on an "AS IS" BASIS,
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
See the License for the specific language governing permissions and
limitations under the License.
```
* The `accounting` application contains the main accounting application.
## Live Demonstration
* The `mia_core` application contains core shared libraries that are used by the
accounting application and my other applications.
https://accounting.imacat.idv.tw/accounting
You may try it in live demonstration at
https://accounting.imacat.idv.tw/accounting .
* Username: `admin`
* Password: `12345`
@ -36,15 +35,13 @@ Install the required packages with `pip`.
pip install django django-dirtyfields titlecase django-decorator-include
```
### Download
The Mia! Accounting project is hosted on GitHub.
https://github.com/imacat/mia-accounting
You can download or clone
the project from from GitHub
You can download or clone the project from from GitHub
```
git clone git@github.com:imacat/mia-accounting.git
@ -129,4 +126,20 @@ base template `base.html`.
Address all bugs and support requests to imacat@mail.imacat.idv.tw.
2020/9/7
## Copyright
```
Copyright (c) 2020 imacat.
Licensed under the Apache License, Version 2.0 (the "License");
you may not use this file except in compliance with the License.
You may obtain a copy of the License at
http://www.apache.org/licenses/LICENSE-2.0
Unless required by applicable law or agreed to in writing, software
distributed under the License is distributed on an "AS IS" BASIS,
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
See the License for the specific language governing permissions and
limitations under the License.
```