From ecb24e40d59ded6e939c4734ecc2101c5b196e49 Mon Sep 17 00:00:00 2001 From: hedgecrw85 Date: Wed, 11 Mar 2015 17:39:13 -0500 Subject: [PATCH] Updated documentation --- .gitignore | 1 + README | 6 +++--- 2 files changed, 4 insertions(+), 3 deletions(-) diff --git a/.gitignore b/.gitignore index e4483f1..598d5af 100644 --- a/.gitignore +++ b/.gitignore @@ -1,5 +1,6 @@ *.class bin +site # Mobile Tools for Java (J2ME) .mtj.tmp/ diff --git a/README b/README index 1345fc1..a839637 100644 --- a/README +++ b/README @@ -13,10 +13,10 @@ For usage examples, please refer to the Usage Wiki at https://github.com/Fazecas TROUBLESHOOTING ----------------- -If you are using Linux and this library does not appear to be working, ensure that you have the correct permissions set to access the serial port on your system. One way to test this is to run your application as root or by using the 'sudo' command. If everything works, you will need to either run your application as root in the future or fix the permissions on your system. For some examples of how to do this, refer to http://jesin.tk/fix-serial-port-permission-denied-errors-linux/. +If you are using Linux and this library does not appear to be working, ensure that you have the correct permissions set to access the serial port on your system. One way to test this is to run your application as root or by using the 'sudo' command. If everything works, you will need to either run your application as root in the future or fix the permissions on your system. For further instructions, refer to the Troubleshooting Wiki at https://github.com/Fazecast/jSerialComm/wiki/Troubleshooting. An additional note for Linux users: If you are operating this library in event-based mode, the LISTENING_EVENT_DATA_WRITTEN event will never occur. This is not a bug, but rather a limitation of the Linux operating system. -For other troubleshooting issues, please see if you can find an answer in the Usage Wiki at https://github.com/Fazecast/jSerialComm/wiki/Usage-Examples. +For other troubleshooting issues, please see if you can find an answer in either the Usage Wiki at https://github.com/Fazecast/jSerialComm/wiki/Usage-Examples or the Troubleshooting Wiki at https://github.com/Fazecast/jSerialComm/wiki/Troubleshooting. -If your question is still not answered, feel free to open an issue report on this project's GitHub page, and we will be glad to look into it. +If your question is still not answered, feel free to open an issue report on this project's GitHub page (https://github.com/Fazecast/jSerialComm/issues), and we will be glad to look into it.