From 419763e3039a97c548738176275e84f8d27588cc Mon Sep 17 00:00:00 2001 From: Ramana Date: Thu, 28 Jun 2018 12:04:42 +0530 Subject: Readme update --- README.md | 49 ++++++++++++++++++++++++++++++++++--------------- 1 file changed, 34 insertions(+), 15 deletions(-) (limited to 'README.md') diff --git a/README.md b/README.md index 38e0436..68b7901 100644 --- a/README.md +++ b/README.md @@ -1,7 +1,36 @@ +# About LDMicro +LDmicro is a ladder logic editor, simulator and compiler for 8-bit microcontrollers. It can generate native code for Atmel AVR and Microchip PIC16 CPUs from a ladder diagram. + # LDMicro for Linux -This is a linux compatible version of the original LDMicro program. +This is a Linux compatible version of the original LDMicro program for windows created by Jonathan Westhues, and proted to Linux under [FOSSEE](https://github.com/FOSSEE) fellowship program 2018 by [R Ramana](https://github.com/Rr42) and [Rohit I](https://github.com/NatsuDrag9). + +GitHub repository of LDMicro for windows can be found [here](https://github.com/akshay-c/LDmicro). + +# Instructions +Before modifying contents of this git account, kindly make sure that you do not add unnecessary files that are created during the make process. In order to do so ensure that you add appropriate command to the makefile and execute "make clean" script before uploading your changes to git. + +# Building LDMicro for Linux +LDmicro for Linux is built using MinGW C++ compiler. + +### Building the Makefile +In order to generate the Makefile that can be used to compile the project, simply run the following commands from a terminal in the project directory: +``` +cd /LDmicro/ +mkdir build +cd build/ +cmake .. +``` -GitHub repository of LDMicro for windows can be found [here](https://github.com/akshay-c/LDmicro) +### Building LDMicro for Linux +Simply run `make` in the build directory of the project to compile. + +_Note_: In order to compile the Makefile must first be generated (see [Building the Makefile](#building-the-makefile)). + +Multiple Perl Scripts are executed during the build phase. In order to execute these scripts, you need perl. This project uses ActivePerl Community Edition, which can be obtained from the following website: + +http://www.activestate.com/activeperl + +or install the perl packages from the terminal (see [External package dependencies](#external-package-dependencies)). ## External package dependencies The install commands for all the packages required to compile LDMicro for Linux are given below: @@ -17,19 +46,9 @@ _Note_: Be sure to run `sudo apt-get update` and `sudo apt-get upgrade` before r ``` * Perl: `sudo apt-get install perl` -## LDMicro for Linux can be compiled and run using the following commands -### To cmpile using cmake use the following commands -``` -cd /LDmicro/ -mkdir build -cd build/ -cmake .. -make -``` -### To run program in linux use the following command - -# To run program in shell mode use the below command +## Running and testing LDMicro for Linux +### To run program in shell mode use the below command `./LDmicro /c <.ld file to compile> <.hex destination file>` -# To run program in GUI mode use the below command +### To run program in GUI mode use the below command `sudo ./LDMicro` -- cgit From 166e0ab7e55118c202e45eb7533164d023978684 Mon Sep 17 00:00:00 2001 From: Ramana Date: Thu, 28 Jun 2018 12:07:08 +0530 Subject: Minor changes to readme. --- README.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) (limited to 'README.md') diff --git a/README.md b/README.md index 68b7901..d0df7ab 100644 --- a/README.md +++ b/README.md @@ -2,7 +2,7 @@ LDmicro is a ladder logic editor, simulator and compiler for 8-bit microcontrollers. It can generate native code for Atmel AVR and Microchip PIC16 CPUs from a ladder diagram. # LDMicro for Linux -This is a Linux compatible version of the original LDMicro program for windows created by Jonathan Westhues, and proted to Linux under [FOSSEE](https://github.com/FOSSEE) fellowship program 2018 by [R Ramana](https://github.com/Rr42) and [Rohit I](https://github.com/NatsuDrag9). +This is a Linux compatible version of the original LDMicro program for windows created by Jonathan Westhues, and proted to Linux under [FOSSEE](https://github.com/FOSSEE) fellowship program 2018 by [R Ramana](https://github.com/Rr42) and [Rohit I](https://github.com/NatsuDrag9), under the mentorship of [Akshay C](https://github.com/akshay-c). GitHub repository of LDMicro for windows can be found [here](https://github.com/akshay-c/LDmicro). -- cgit From d49887b15a0abb17d7687e8b96b4e5ffb0c75677 Mon Sep 17 00:00:00 2001 From: Ramana Date: Thu, 28 Jun 2018 12:12:46 +0530 Subject: Minor changes to readme. --- README.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) (limited to 'README.md') diff --git a/README.md b/README.md index d0df7ab..0f0b022 100644 --- a/README.md +++ b/README.md @@ -2,7 +2,7 @@ LDmicro is a ladder logic editor, simulator and compiler for 8-bit microcontrollers. It can generate native code for Atmel AVR and Microchip PIC16 CPUs from a ladder diagram. # LDMicro for Linux -This is a Linux compatible version of the original LDMicro program for windows created by Jonathan Westhues, and proted to Linux under [FOSSEE](https://github.com/FOSSEE) fellowship program 2018 by [R Ramana](https://github.com/Rr42) and [Rohit I](https://github.com/NatsuDrag9), under the mentorship of [Akshay C](https://github.com/akshay-c). +This is a Linux compatible version of the original LDMicro program for windows created by Jonathan Westhues, and proted to Linux under [FOSSEE](https://github.com/FOSSEE) fellowship program 2018 by [Ramana R](https://github.com/Rr42) and [Rohit I](https://github.com/NatsuDrag9), under the mentorship of [Akshay C](https://github.com/akshay-c). GitHub repository of LDMicro for windows can be found [here](https://github.com/akshay-c/LDmicro). -- cgit