Skip to content

Fixed markdown syntax in README.md #32

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
dylan-cooper wants to merge 1 commit into
base: master
Choose a base branch
from
Open

Fixed markdown syntax in README.md #32

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
66 changes: 33 additions & 33 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,9 +1,9 @@
#What is it?
# What is it?
Fragaria is an OS X Cocoa syntax colouring NSTextView implemented within a framework named MGSFragaria. It supports a wide range of programming languages and includes preference panel support.

The MGSFragaria framework now properly supports both traditional reference counting memory management and garbage collection.

#Where can I see it in use
# Where can I see it in use

You can see Fragaria used in the following projects and products:

Expand All @@ -21,7 +21,7 @@ You can see Fragaria used in the following projects and products:

If you use Fragaria in your app and want it added to the list just let us know or edit the README.

#Features
# Features

Most features are accessed via the framework preferences.

Expand All @@ -36,7 +36,7 @@ Most features are accessed via the framework preferences.
* Line wrapping


##How do I use it?
## How do I use it?

The best way to learn how to use the framework is to look at the sample apps.

Expand All @@ -46,7 +46,7 @@ The best way to learn how to use the framework is to look at the sample apps.

* __Fragaria Doc__ : a simple NSDocument based editor.

##Show me code
## Show me code

A Fragaria view is embedded in a content view.

Expand Down Expand Up @@ -84,7 +84,7 @@ MGSFragariaFontsAndColoursPrefsViewController *fontsAndColoursPrefsViewControlle
```


##Setting preferences
## Setting preferences

Preference strings are defined in MGSFragaria/MGSFragariaPreferences.h. Each preference name is prefixed with Fragaria for easy identification within the application preferences file.

Expand All @@ -97,7 +97,7 @@ Preference strings are defined in MGSFragaria/MGSFragariaPreferences.h. Each pre
All preferences are observed and instances of Fragaria views update immediately to reflect the new preference.


##Breakpoint Highlighting
## Breakpoint Highlighting

Use the `MGSFOBreakpointDelegate` key to define a breakpoint delegate that responds to conforms to `MGSBreakpointDelegate`

Expand All @@ -124,7 +124,7 @@ fragaria.syntaxErrors = @[syntaxError];

The implementation of this feature is at an early stage. Feel free to improve it.

##Custom colouring
## Custom colouring

The `SMLSyntaxColouringDelegate` protocol allows a delegate to influence the syntax colouring for each of a number of syntactical groups such as numbers, attributes, comments or keywords.

Expand Down Expand Up @@ -158,10 +158,10 @@ The delegate can completely override the colouring for a given group or provide
For more details see [SMLSyntaxColouringDelegate.h](SMLSyntaxColouringDelegate.h) and the example code in [FragariaAppDelegate.m](FragariaAppDelegate.m).


##Supported languages
## Supported languages
Fragaria supports syntax colouring for a wide range of programming languages and configuration file formats:

###A
### A
actionscript,
actionscript3,
active4d,
Expand All @@ -177,10 +177,10 @@ aspdotnet-cs,
aspdotnet-vb,
awk

###B
### B
batch (shell)

###C
### C
C,
cobol,
coffeescript,
Expand All @@ -190,63 +190,63 @@ csharp,
csound,
css

###D
### D
D,
dylan

###E
### E
eiffel, erl, eztpl

###F
### F
F-script,
fortran,
freefem

###G
### G
gedcom,
gnuassembler,
graphviz

###H
### H
haskell,
header,
html

###I
### I
idl

###J
### J
java,
javafx,
javascript,
jsp

###L
### L
latex,
lilypond,
lisp,
logtalk,
lsl,
lua

###M
### M
matlab,
mel,
metapost,
metaslang,
mysql,
nemerle,

###N
### N
nrnhoc


###O
### O
objectivec,
objectivecaml,
ox

###P
### P
pascal,
pdf,
perl,
Expand All @@ -256,12 +256,12 @@ postscript,
prolog,
python

###R
### R
r,
rhtml,
ruby

###S
### S
scala,
sgml,
shell,
Expand All @@ -270,33 +270,33 @@ sql,
stata,
supercollider

###T
### T
tcltk,
torquescript

###U
### U
udo

###V
### V
vb,
verilog,
vhdl

###X
### X
xml

##Defining a new language syntax
## Defining a new language syntax

To define a new syntax definition:

1. Generate a plist that defines the language syntax. The plist structure is simple and browsing the [existing definitions](Syntax%20Definitions) should provide some enlightenment. The plist keys are defined in ` SMLSyntaxDefinition.h`. For much deeper insight see `SMLSyntaxColouring - recolourRange:`.

2. Insert a reference to the new plist into [SyntaxDefinitions.plist](SyntaxDefinitions.plist)

#How can I contribute
# How can I contribute
Take a look at the [TODO](TODO.md) list.

##Where did it come from?
## Where did it come from?
Fragaria started out as the vital pulp of Smultron, now called Fraise. If you want to add additional features to Fragaria then looking at the [Fraise](https://github.com/jfmoy/Fraise) and other forked sources is a good place to start. Fraise is a GC only app so you will need to consider memory management issues when importing code into Fragaria.


Expand Down