From e57a97c6010dfd8d46cf671d38f85dd55ed31807 Mon Sep 17 00:00:00 2001 From: Aidan Date: Mon, 20 Jul 2020 09:42:18 -0700 Subject: [PATCH] update readme --- Readme.md | 11 +++++++++-- 1 file changed, 9 insertions(+), 2 deletions(-) diff --git a/Readme.md b/Readme.md index 63d0b30..448e0b5 100644 --- a/Readme.md +++ b/Readme.md @@ -2,7 +2,7 @@ Syntactically Homogeneous Shell ## 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 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")) ``` +## 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 - 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 Copyright (C) 2019 Aidan Hahn.