diff --git a/README b/LICENSE similarity index 59% rename from README rename to LICENSE index 0028a84..f95bb04 100644 --- a/README +++ b/LICENSE @@ -1,31 +1,5 @@ -libspnav - 0.2.2 ----------------- - -1. About - -The libspnav library is provided as a replacement of the magellan library. It -provides a cleaner, and more orthogonal interface. libspnav supports both the -original X11 protocol for communicating with the driver, and the new -alternative non-X protocol. Programs that choose to use the X11 protocol, are -automatically compatible with either the free spacenavd driver or the official -3dxserv, as if they were using the magellan SDK. - -Also, libspnav provides a magellan API wrapper on top of the new API. So, any -applications that were using the magellan library, can switch to libspnav -without any changes. And programmers that are familliar with the magellan API -can continue using it with a free library without the restrictions of the -official SDK. - - -2. Installation - -Configure, make, and make install as usual. - - -3. License - libspnav is part of the spacenav project (spacenav.sf.net) -Copyright (C) 2007-2009 John Tsiombikas +Copyright (C) 2007-2018 John Tsiombikas Redistribution and use in source and binary forms, with or without modification, are permitted provided that the following conditions are met: diff --git a/README.md b/README.md new file mode 100644 index 0000000..79eb98a --- /dev/null +++ b/README.md @@ -0,0 +1,33 @@ +libspnav +======== + +About +----- + +The libspnav library is provided as a replacement of the magellan library. It +provides a cleaner, and more orthogonal interface. libspnav supports both the +original X11 protocol for communicating with the driver, and the new +alternative non-X protocol. Programs that choose to use the X11 protocol, are +automatically compatible with either the free spacenavd driver or the official +3dxserv, as if they were using the magellan SDK. + +Also, libspnav provides a magellan API wrapper on top of the new API. So, any +applications that were using the magellan library, can switch to libspnav +without any changes. And programmers that are familliar with the magellan API +can continue using it with a free library without the restrictions of the +official SDK. + + +Installation +------------ + +Configure, make, and make install as usual. + + +License +------- + +Copyright (C) 2007-2018 John Tsiombikas + +libspnav is free software. Feel free to use, modify, and/or redistibute it +under the terms of the 3-clause BSD license. See LICENSE for details.