Introduce a Contributing info file
This commit is contained in:
parent
1ab1c02fd4
commit
c2f3701c8c
2 changed files with 52 additions and 1 deletions
22
CONTRIBUTING.md
Normal file
22
CONTRIBUTING.md
Normal file
|
@ -0,0 +1,22 @@
|
||||||
|
# BugVault
|
||||||
|
|
||||||
|
Welcome to BugVault!
|
||||||
|
|
||||||
|
This project aims to create a fully featured bug tracker, written in Flutter, designed for ease of use, without compromising on functionality.
|
||||||
|
|
||||||
|
## **IMPORTANT**
|
||||||
|
|
||||||
|
This project uses Hungarian Notation. Any contributions must likewise use Hungarian Notation.
|
||||||
|
|
||||||
|
Please see the table below for mappings. _NOTE_: All globals will use a `g_` prefix to indicate the variable is in a global context.
|
||||||
|
|
||||||
|
| Prefix | Purpose |
|
||||||
|
| ------ | ---------------- |
|
||||||
|
| s | String |
|
||||||
|
| i | Integer |
|
||||||
|
| b | Boolean |
|
||||||
|
| ix | Bitmask |
|
||||||
|
| v | Vector |
|
||||||
|
| L/l | List |
|
||||||
|
| d | Double |
|
||||||
|
| m | Map / Dictionary |
|
31
README.md
31
README.md
|
@ -1,3 +1,32 @@
|
||||||
# BugVault
|
# BugVault
|
||||||
|
|
||||||
Open Source GPL3 bug tracker. This bug tracker prioritizes ease of use.
|
Open Source GPL3 bug tracker. This bug tracker prioritizes ease of use.
|
||||||
|
|
||||||
|
# Compilation
|
||||||
|
|
||||||
|
## Linux
|
||||||
|
|
||||||
|
To build for Linux, you are going to want to run the following command:
|
||||||
|
|
||||||
|
```bash
|
||||||
|
flutter pub get
|
||||||
|
flutter build linux
|
||||||
|
```
|
||||||
|
|
||||||
|
## Android
|
||||||
|
|
||||||
|
To build for Android, run the following command:
|
||||||
|
|
||||||
|
```bash
|
||||||
|
flutter pub get
|
||||||
|
flutter build apk
|
||||||
|
```
|
||||||
|
|
||||||
|
## Windows
|
||||||
|
|
||||||
|
To build for Windows, run the following command:
|
||||||
|
|
||||||
|
```bat
|
||||||
|
flutter pub get
|
||||||
|
flutter build windows
|
||||||
|
```
|
||||||
|
|
Loading…
Add table
Add a link
Reference in a new issue