Commit aed1f395 authored by ‏'s avatar Committed by Patrick Storz

Corrected a few spelling and formatting errors in the markdown files.

parent e4462fc8
Pipeline #66448480 passed with stages
in 121 minutes and 25 seconds
Contributing to Inkscape
========================
Inkscape welcomes your contributions to help turn it into a fully
SVG-compliant drawing program for the Open Source community.
SVG-compliant drawing program for the Open Source community.
While many developers work on fixing bugs and creating new features, it
is worth strong emphasis that even non-programmers can help make
Inkscape more powerful and successful. You probably already have an idea
of something you'd like to work on. If not, here are just a few ways you
can help:
can help:
* Pick a bug, fix it, and send in a merge request on gitlab.
* Pick a bug, fix it, and send in a merge request on GitLab.
* Choose a feature you want to see developed, and make it.
* If you speak a language in addition to English, work on your
language's i18n file in the po/ directory.
......@@ -21,43 +22,47 @@ can help:
GIT Access
==========
Inkscape is currently developed on git, with the code hosted on gitlab.
----------
Inkscape is currently developed on git, with the code hosted on GitLab.
* https://gitlab.com/inkscape/inkscape
We give write access out to people with proven interest in helping develop
the codebase. Proving your interest is straightforward: Make two
the codebase. Proving your interest is straightforward: Make two
contributions and request access.
Compiling the development version
=================================
---------------------------------
See http://wiki.inkscape.org/wiki/index.php/CompilingInkscape for general
remarks about compiling, including how to find some of the needed packages for
your distribution, and suggestions for developers.
Patch Decisions
===============
---------------
Our motto for changes to the codebase is "Patch first, ask questions
later". When someone has an idea, rather than endlessly debating it, we
later". When someone has an idea, rather than endlessly debating it, we
encourage folks to go ahead and code something up (even prototypish).
This is then incorporated into the development branch of the code for
folks to try out, poke and prod, and tinker with. We figure, the best
folks to try out, poke and prod, and tinker with. We figure, the best
way to see if an idea fits is to try it on for size.
Coding Style
============
------------
Please refer to the Coding Style Guidelines
(https://inkscape.org/en/develop/coding-style/) if you have specific questions
on the style to use for code. If reading style guidelines doesn't interest
on the style to use for code. If reading style guidelines doesn't interest
you, just follow the general style of the surrounding code, so that it is at
least consistent.
Documentation
=============
-------------
Code needs to be documented. Future Inkscape developers will really
appreciate this. New files should have one or two lines describing the
......@@ -65,7 +70,7 @@ purpose of the code inside the file.
Building
========
--------
This is the best set of instructions for setting up your build directory...
......@@ -74,7 +79,7 @@ You should install ninja and ccache for the fastest build:
```bash
sudo apt-get install ninja-build ccache
```
Next we prepare a build directory with a symlink to Inkscape's share folder, add a profile dir and set the bin folder (optional):
```bash
......@@ -96,14 +101,14 @@ Invoke ninja to build the code. You may also use plain gcc's `make` if you didn'
ninja
```
Now we can run inkscape that we have built, with the latest resources and code:
Now we can run `inkscape` that we have built, with the latest resources and code:
```bash
./bin/inkscape
```
Testing
=======
-------
Before landing a patch, the unit tests should pass.
......
Installation
============
Basic Installation
==================
------------------
Inkscape version 0.92 and newer can be build using cmake:
Inkscape version 0.92 and newer can be build using CMake:
```sh
mkdir build
......@@ -15,40 +18,40 @@ Other platforms such as Windows and Mac require a lot more and are considered
a developer and packager task. These instructions are kept on the Inkscape wiki.
Running Without Installing
==========================
--------------------------
For developers and others who want to run inkscape without installing it please
For developers and others who want to run Inkscape without installing it please
see the ***Building*** section in the `CONTRIBUTING.md` file.
Required Dependencies
=====================
---------------------
The Inkscape core depends on several other libraries that you will need
install, if they are not already present on your system. The most
install, if they are not already present on your system. The most
typical libraries you may need to install are:
* [Boehm-GC](http://www.hboehm.info/gc/)
* [libsigc++](https://github.com/libsigcplusplus/libsigcplusplus)
* [gtkmm](https://www.gtkmm.org/)
* [Boehm-GC](http://www.hboehm.info/gc/)
* [libsigc++](https://github.com/libsigcplusplus/libsigcplusplus)
* [gtkmm](https://www.gtkmm.org/)
Please see [the wiki page on compiling Inkscape](http://wiki.inkscape.org/wiki/index.php/CompilingInkscape) for the
most current dependencies, including links to the source tarballs.
Extensions
==========
----------
All inkscape extensions have been moved into their own reporsitory, they
All Inkscape extensions have been moved into their own repository. They
can be installed from there and should be packaged into builds directly.
Report all bugs and ideas to that sub project.
[Inkscape Extensions](https://gitlab.com/inkscape/extensions/)
Build Options
=============
-------------
A number of configuration settings can be overridden through cmake. To
see a list of the options available for inkscape, run:
A number of configuration settings can be overridden through CMake. To
see a list of the options available for Inkscape, run:
```sh
cmake -L
......@@ -59,13 +62,13 @@ or, for more advanced cmake settings:
cmake --help
```
For example, to build inkscape with only SVG 1 support, and no SVG 2, do:
For example, to build Inkscape with only SVG 1 support, and no SVG 2, do:
```sh
cmake .. -DWITH_SVG2=OFF
```
Or, to build inkscape with debugging symbols, do:
Or, to build Inkscape with debugging symbols, do:
```sh
cmake -DCMAKE_BUILD_TYPE=Debug ..
......
......@@ -4,8 +4,8 @@ Inkscape. Draw Freely.
[https://www.inkscape.org/](https://www.inkscape.org/)
Inkscape is an open source drawing tool with capabilities similar to
Illustrator, Freehand, and CorelDraw that uses the W3C standard scalable
vector graphics format (SVG). Some supported SVG features include
Illustrator, Freehand, and CorelDRAW that uses the W3C standard scalable
vector graphics format (SVG). Some supported SVG features include
basic shapes, paths, text, markers, clones, alpha blending, transforms,
gradients, and grouping. In addition, Inkscape supports Creative Commons
meta-data, node-editing, layers, complex path operations, text-on-path,
......
Packaging
=========
This directory contains files and utilities for creating source and
binary packages of Inkscape. Items in this directory typically are not
binary packages of Inkscape. Items in this directory typically are not
referenced, used, or included in the regular Inkscape builds.
This is the root dir for Inkscape's resources that it loads at runtime:
icons, markers, filters, keyboard maps, etc.
attributes -
branding - Official visual collateral
examples - Shareable example drawings
extensions - Pluggable scripts runnable by Inkscape
filters - Custom SVG filters loaded at runtime, under Effects > Filters
fonts -
gradients -
icons - Program icons following the freedesktop.org icon scheme.
keys -
markers -
palettes -
patterns -
screens -
symbols -
templates -
tutorials -
ui -
Directory | Description
-------------|--------------------------------------------------------------
`attributes` |
`branding` | Official visual collateral
`examples` | Shareable example drawings
`extensions` | Pluggable scripts runnable by Inkscape
`filters` | Custom SVG filters loaded at runtime, under Effects > Filters
`fonts` |
`gradients` |
`icons` | Program icons following the freedesktop.org icon scheme.
`keys` |
`markers` |
`palettes` |
`patterns` |
`screens` |
`symbols` |
`templates` |
`tutorials` |
`ui` |
This directory and ../snappy/ are used for building the snap (https://snapcraft.io/) package of inkscape.
Snap
====
This directory and `../snappy/` are used for building the snap (https://snapcraft.io/) package of Inkscape.
Each commit to master sends a new build to the "edge" version.
For build status and logs, see: https://launchpad.net/~ted/+snap/inkscape-master
That account on launchpad.net is owned by Ted Gould <ted@gould.cx>.
For build status and logs, see https://launchpad.net/~ted/+snap/inkscape-master. That account on launchpad.net is owned by Ted Gould <ted@gould.cx>.
If the snap does no longer build or run, the most probable reason is that we added a new dependency. Have a look at the recent changes in https://gitlab.com/inkscape/inkscape-ci-docker , and try to make a similar change to "build-packages" (build dependency) or "stage-packages" (runtime dependency) in snapcraft.yaml.
If the snap does no longer build or run, the most probable reason is that we added a new dependency. Have a look at the recent changes in https://gitlab.com/inkscape/inkscape-ci-docker, and try to make a similar change to `build-packages` (build dependency) or `stage-packages` (runtime dependency) in `snapcraft.yaml`.
Markdown is supported
0% or
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment