diff --git a/README.txt b/README.md similarity index 80% rename from README.txt rename to README.md index 4d3f2ac..161d5cf 100644 --- a/README.txt +++ b/README.md @@ -1,17 +1,16 @@ -Sagi Dayan 2014 +###Sagi Dayan 2014 ------------------------------ -OS course Ex1 - Home - cshell - LINUX/UNIX ------------------------------ -this project is a basic Terminal emulator written in C for OS course in JCE. +# OS course Ex1 - Home - cshell - LINUX/UNIX +## a basic Terminal emulator written in C for OS course in JCE. This Terminal will be able to run almost all programs in the PATH /bin/ and will create a new process of that . the Prompt format: +``` @$ - +``` the exit code is the Return code from the last child process. if 0 -> child ended successfully. @@ -19,23 +18,33 @@ for more details see Q&A sagi dayan (c) 2014. ------------- -Build & Run & Exit ------------- -To build cshell run in terminal: make -and run with the command: cshell -to quit run from cshell: exit -to clean the directory run: make clean +# Build & Run & Exit + +To build cshell run in terminal: +``` +$ make +``` +and run with the command: +``` +$ cshell +``` +to quit run from cshell: +``` +$ exit +``` +to clean the directory run: +``` +$ make clean +``` + +# Design Decisions & Issues -------------------------- -Design Decisions & Issues -------------------------- the main idea is to be able to run & create processes via commands. you can enter almost any basic command (and some more) that the binarys are in PATH /bin/ . -Main issues: +### Main issues: * you cannot navigate to different directories. * you cannot pipe command and arguments. * every word will be treated as an argumant! @@ -52,13 +61,15 @@ Main issues: -------- -Q&A -------- + +# Q&A + Q: can i redirect output to a file? A: yes you can. use the "redirect" char '>' and then the file name. like so: + ```shell $ man ls > myFile.txt + ``` Note: the content of the file Will be deleted, in othe words, it acts exactly like '>' in the UNIX Shell. not '>>'. Note2: the file name must be in one word. as you can see in Issues,