From 0cb4079560ba919c89769969a419e4503cc30514 Mon Sep 17 00:00:00 2001 From: Alexandre Date: Fri, 31 Jan 2025 17:04:55 +0100 Subject: [PATCH] Changed the README to update it to the current state of the project --- README.md | 18 +++++++++++++++++- main.go | 2 +- 2 files changed, 18 insertions(+), 2 deletions(-) diff --git a/README.md b/README.md index 0dde6c0..b9d0b84 100644 --- a/README.md +++ b/README.md @@ -12,4 +12,20 @@ If not, the issue will be fixed soon (in case of a typo for example) ## Installation You can grab the binaries for your system and architecture, or build it yourself -To build it, clone the repository, cd into it and run go +To build it, clone the repository, cd into it and run +'go build -o bin/GoSH' +To test the shell and see if it suits you. +If everything works, then move the binary to a place inside your path. + +To directly install it with the Go toolchain, just use 'go intall' +This will build and place the binary inside your $HOME/go/bin folder. +Add this folder to your path and you are good to go ! + +## Usage +To use the program, just invoke it with 'GoSH' +If you see a message about a config file, create '~/.config/gosh/gosh_config.toml' and populate it with the defaults written inside this repo. +To change config parameter on the fly, use the 'set' builtin. +Currently, 'set' has a limited amount of configuration options. +To change the color of the prompt use 'set color ' +You can use all "console colors", listed [https://gist.github.com/kamito/704813 | here] + diff --git a/main.go b/main.go index fe077b0..e28c3cf 100644 --- a/main.go +++ b/main.go @@ -67,7 +67,7 @@ func main() { // Charger la configuration depuis un fichier func loadConfig() { homeDir, _ := os.UserHomeDir() - configPath := homeDir + "/.config/gosh/.gosh_config.toml" + configPath := homeDir + "/.config/gosh/gosh_config.toml" fmt.Println("Chemin du fichier de configuration:", configPath) // Log pour déboguer viper.SetConfigFile(configPath)