11# Laser Usage Guide
22
3- After installing Laser on your system, invoke Laser by opening a terminal and
4- typing in 'laser' and hit enter. This will print an 'About' message. Typing in
3+ After installing Laser on your system using the instructions on the
4+ [ README.md] ( README.md ) , invoke Laser by opening a terminal and typing in
5+ 'laser' and hit enter. This will print an 'About' message. Typing in
56'laser -h' will display the following help message:
67
78```
@@ -15,4 +16,55 @@ Usage:
1516 -p: 'laser -p <file1> <file2>' assembles the specified files as a project
1617 'laser -p *.asm' assembles all files in current directory as a project
1718 -c: 'laser -c <file>' removes all files generated during assembly
18- ```
19+ ```
20+ ---
21+ ## Editors
22+
23+ It is a very good idea to find a code editor that you enjoy using- it will make
24+ you much more efficient and may even lessen the pain of editing. Below are some
25+ recommended editors along with instructions on how to set them up.
26+
27+ ### VS Code
28+
29+ This is my current recommendation; it is what I used to develop Laser and it is
30+ what I will be using for the forseeable future. It's a competent text editor,
31+ but it stands out in its extensibility and hackability. I have written and
32+ published an LC3 Extension that should be all you need to get up and running,
33+ including syntax highlighting, tab completion, snippets, and build tasks.
34+
35+ You can download VS Code [ here] ( https://code.visualstudio.com/ ) and my LC3
36+ Extension [ here] ( https://marketplace.visualstudio.com/items?itemName=PaperFanz.lc3-assembly ) .
37+ Both are available for free on Windows, Linux, and Mac OS.
38+
39+ ### Notepad++
40+
41+ * TODO, contributions appreciated*
42+
43+ <!-- Notepad++ is another very good editor, and is a huge improvement over the
44+ default Notepad in Windows. However, the downside is that it is only available
45+ for the Windows operating system and requires a bit of configuration to get to
46+ the level of productivity that VS Code affords. However, this is the editor
47+ that Professor Yeraballi uses, and he has syntax highlighting packs and build
48+ tasks available to copy and use for free. -->
49+
50+ Notepad++ can be found for free [ here] ( https://notepad-plus-plus.org/ ) .
51+
52+ ### Atom
53+
54+ Atom is very similar to VS Code, and is built on the same underlying
55+ technologies. However, at this time there is no extension pack for the LC3 as
56+ there is on VS Code, so you will have to manually set things up if you prefer
57+ Atom. If you really love Atom, you can consider authoring your own extension
58+ pack.
59+
60+ Atom can be found for free [ here] ( https://atom.io/ ) for Windows, Linux, and Mac
61+ OS.
62+
63+ ### Sublime Text
64+
65+ Sublime Text is also very similar to VS Code, but like Atom lacks an LC3
66+ extension. Much like Atom, there are extensive APIs for you to author your own
67+ extension if you so wish.
68+
69+ Sublime Text is avalable on Windows, Linux, and Mac OS for free on their
70+ [ website] ( https://www.sublimetext.com/ ) .
0 commit comments