vom's Introduction

ReadMe

(1) Contents

(1) Contents
(2) Introduction
(3) Use
(4) Environment
(5) Build
(6) About

(2) Introduction

This code is a simple file editor for text files built in the same spirit as Vim, with much the same commands where possible.

The following are the main goals of the program:

Small binary size (< 20kB)
Simple use (lower number of commands)
Automatic colouring
Fast
Low RAM usage (even for large files)

(3) Use

Below is some examples of the system in use:

(4) Environment

To install the required packages, please run the following (Debian):

sudo apt-get install cmake cppcheck gcc git libncurses5-dev pandoc

cmake - Allows for easy building of the system.
cppcheck - Static code analysis for C/C++.
gcc - Allows compilation of the source code.
git - Access to the repository.
libncurses5-dev - Library for the UI of the text editor.
pandoc - Allows compilation of the documentation.

If you require more libraries or this documentation is out of date for any reason, please raise a ticket on GitHub.

(5) Build

Code

Initially, you'll need to run the following command once:

cmake .

After this, only the following command should be required:

make

Documentation

To build the documentation, only a make is required.

(6) About

Written by B[].

vom's People

Contributors

Watchers

vom's Issues

Compile Error

Compile issue:

##@##:~/Documents/vom/vom$ gcc -g src/main.c -lcurses -o vom
In file included from src/layout.c:12:0,
                 from src/main.c:11:
src/display.c: In function ‘display_update’:
src/display.c:76:3: error: ‘for’ loop initial declarations are only allowed in C99 or C11 mode
   for(unsigned int x = 0; x < len; x++){
   ^
src/display.c:76:3: note: use option -std=c99, -std=gnu99, -std=c11 or -std=gnu11 to compile your code
In file included from src/main.c:11:0:
src/layout.c: In function ‘layout_update’:
src/layout.c:87:3: error: ‘for’ loop initial declarations are only allowed in C99 or C11 mode
   for(unsigned int x = 13; x < len; x++){
   ^
src/layout.c:92:20: error: redefinition of ‘x’
   for(unsigned int x = typeLen > width ? typeLen - width : 0; x < typeLen; x++){
                    ^
src/layout.c:87:20: note: previous definition of ‘x’ was here
   for(unsigned int x = 13; x < len; x++){
                    ^
src/layout.c:92:3: error: ‘for’ loop initial declarations are only allowed in C99 or C11 mode
   for(unsigned int x = typeLen > width ? typeLen - width : 0; x < typeLen; x++){
   ^
src/layout.c: In function ‘layout_set_type_buffer’:
src/layout.c:172:3: error: ‘for’ loop initial declarations are only allowed in C99 or C11 mode
   for(unsigned int x = 0; x < TYPE_LEN; x++){
   ^
src/main.c: In function ‘main’:
src/main.c:47:3: error: ‘for’ loop initial declarations are only allowed in C99 or C11 mode
   for(int x = 1; x < argc; x++){
   ^
src/main.c:55:7: error: ‘for’ loop initial declarations are only allowed in C99 or C11 mode
       for(int z = 0; z < len; z++){
       ^
src/main.c: In function ‘main_loop’:
src/main.c:174:17: error: ‘for’ loop initial declarations are only allowed in C99 or C11 mode
                 for(unsigned x = 1; x < tLen; x++){
                 ^

Recommend Projects