Elara6331
/
amu
1
0
Fork 0
Code Issues Pull Requests Projects Releases Wiki Activity

Improve README

This commit is contained in:
Elara 2021-10-04 10:05:24 -07:00
parent 554786792e
commit 68e399c54b
1 changed files with 12 additions and 4 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

16
README.md
View File

@ -6,22 +6,30 @@ AMU is a human readable markup language I made for my own uses and to learn. It
### Purpose
The purpose of this project is to create a markup language for my own use. I will use this primarily for quickly writing simple documents, for example, taking notes in class or doing some quick homework. It fulfills all my needs and I will add things as I need them. There are functions for extensibility when adding a new thing to parse is not justified.
The purpose of this project is to create a markup language for my own use. I have previously added features to other markup languages, but this caused issues in multiple cases. I decided to create a markup language myself instead.
---
### Usage
This repo is a library for parsing AMU. It can be imported and used like any other go library. In `cmd`, there are binaries for interacting with AMU. `cmd/amu` contains a command line program that takes a file with AMU or reads from stdin and outputs HTML. In `cmd/amulive`, there is a Gtk app that provides a real-time preview of the document on the right with a text box on the left.
This repo is a library for parsing AMU. It can be imported and used like any other go library.
#### `amu`
In `cmd/amu`, there is a binary that will read from Stdin with no arguments, or from a file given as the first argument. It will output the generated HTML.
#### `amulive`
In `cmd/amulive`, there is a Gtk app that has a text box on the left and a webview on the right. It displays the generated HTML on the right as you type into the text box.
---
### Syntax
The syntax for most of AMU's features can be seen in test.amu in this repo.
The syntax for most of AMU's features can be seen in `test.amu` in this repo.
---
### Performance
Timing this program using the test file, I consistently get 4ms run time on my XPS 13. This is much faster than the projects I have made before for a similar purpose, although it is likely unnoticeable for most people.
Timing this program using `test.amu`, I consistently get 4ms run time. This is much faster than my previous modified markup languages. It is likely unnoticeable in most cases, but interesting nonetheless.