affine/SHS
1
0
Fork 0
Code Issues Pull requests Projects Releases Packages Wiki Activity Actions

update readme

Browse source
This commit is contained in:
Aidan 2020-07-20 09:42:18 -07:00
parent 44521f306f
commit e57a97c601
No known key found for this signature in database
GPG key ID: 327711E983899316
1 changed files with 9 additions and 2 deletions
Download patch file Download diff file Expand all files Collapse all files

11
Readme.md
View file

@ -2,7 +2,7 @@
Syntactically Homogeneous Shell Syntactically Homogeneous Shell
## Overview ## Overview
This shell was created to have extremely simple syntax. S-Expressions were chosen to represent statements and the scope of language features were constrained to what could be considered practical for daily shell use. This program is meant to be practical for administrators and daily power users. This shell was created to have extremely simple syntax. S-Expressions were chosen to represent statements and the scope of language features were constrained to what could be considered practical for daily shell use. This program is meant to be practical for administrators and daily power users. It can be used for both system administration (as one might use bash or zsh) as well as for the creation of simple programs.
## Basic Syntax ## Basic Syntax
When in doubt the `print_ast` utility can be used to examine the output of the Lex+Parse process. Here you can spot any bugs regarding syntax. When in doubt the `print_ast` utility can be used to examine the output of the Lex+Parse process. Here you can spot any bugs regarding syntax.
@ -94,9 +94,16 @@ Here is an example of a shs configuration file:
(func _SH_PROMPT () (concat (?) ($ basename ($ pwd)) "\n")) (func _SH_PROMPT () (concat (?) ($ basename ($ pwd)) "\n"))
``` ```
## The Docs
- [Documentation on language interpreter](https://godoc.org/gitlab.com/whom/shs/ast)
- [Documentation on logging module](https://godoc.org/gitlab.com/whom/shs/log)
- [Documentation on configuration module](https://godoc.org/gitlab.com/whom/shs/config)
- [Documentation on utility functions](https://godoc.org/gitlab.com/whom/shs/util)
- [Documentation on standard library](https://godoc.org/gitlab.com/whom/shs/stdlib)
- [Guide to standard library](https://gitlab.com/whom/shs/-/blob/master/stdlib/Readme.md)
## Contributing ## Contributing
- Any contribution to this software is welcome as long as it adheres to the conduct guidelines specified in the `Contributing.md` file in this repository. - Any contribution to this software is welcome as long as it adheres to the conduct guidelines specified in the `Contributing.md` file in this repository.
- Consider reading the [STDLIB Readme](https://git.callpipe.com/aidan/shs/-/blob/master/stdlib/Readme.md) for more information on how to extend this project.
## License ## License
Copyright (C) 2019 Aidan Hahn. Copyright (C) 2019 Aidan Hahn.