Rename lib to libserialport

Signed-off-by: Euan Torano <[email protected]>
euantorano · Feb 12, 2017 · 77e8c97 · 77e8c97
1 parent c0b5d3f
commit 77e8c97
Show file tree

Hide file tree

Showing 14 changed files with 80 additions and 78 deletions.
diff --git a/README.md b/README.md
@@ -1,24 +1,25 @@
-# serialport.nim
+# libserialport.nim
 
 A library to work with serial ports using pure Nim.
 
 ## Installation
 
 ```
-nimble install serialport
+nimble install libserialport
 ```
 
 ## Usage
 
 ### Reading from a serial port, into a pre-defined buffer:
 
 ```nim
-import serialport
+import libserialport
 
 let port = openSerialPort("COM3",
  baudRate=BaudRate.BR9600, dataBits=DataBits.eight,
  stopBits=StopBits.one, parity=Parity.none,
  useHardwareFlowControl=true, useSoftwareFlowControl=false)
+defer: port.close()
 
 ## The baud rate, data bits, stop bits and parity default to 9600, 8, 1 and none - in that order
 
@@ -44,12 +45,13 @@ echo "Read ", numRead, " bytes from the serial port: ", readBuffer
 ### Writing to a serial port:
 
 ```nim
-import serialport
+import libserialport
 
 let port = openSerialPort("COM3",
  baudRate=BaudRate.BR9600, dataBits=DataBits.eight,
  stopBits=StopBits.one, parity=Parity.none,
  useHardwareFlowControl=true, useSoftwareFlowControl=false)
+defer: port.close()
 
 ## The baud rate, data bits, stop bits and parity default to 9600, 8, 1 and none - in that order
 
@@ -76,7 +78,7 @@ port.write(newDataToSend, timeout=5) # Wait for 5 seconds. If the data isn't tra
 ### Listing serial ports available on the system
 
 ```nim
-import serialport
+import libserialport
 
 for p in listSerialPorts():
  echo "Found serial port: ", p

diff --git a/docs/serialport.html → docs/libserialport.html b/docs/serialport.html → docs/libserialport.html
diff --git a/examples/list_serial_ports.nim b/examples/list_serial_ports.nim
@@ -1,4 +1,4 @@
-import serialport
+import libserialport
 
 when isMainModule:
  proc main() =

diff --git a/examples/read_write.nim b/examples/read_write.nim
@@ -1,4 +1,4 @@
-import serialport, os
+import libserialport, os
 
 const
  writePort: string = "/dev/cu.usbserial-FTZ9WDJA"

diff --git a/serialport.nimble → libserialport.nimble b/serialport.nimble → libserialport.nimble
@@ -12,4 +12,4 @@ srcDir = "src"
 requires "nim >= 0.15.2"
 
 task docs, "Build documentation":
- exec "nim doc2 -o:docs/serialport.html src/serialport.nim"
+ exec "nim doc2 -o:docs/libserialport.html src/libserialport.nim"
diff --git a/src/serialport.nim → src/libserialport.nim b/src/serialport.nim → src/libserialport.nim
@@ -1,6 +1,6 @@
 ## A library to work with serial ports using pure Nim.
 
-include serialport/private/list_serialports, serialport/private/common
+include libserialport/private/list_serialports, libserialport/private/common
 
 when defined(nimdoc):
  proc openSerialPort*(name: string, baudRate: BaudRate = BaudRate.BR9600,

diff --git a/src/serialport/private/common.nim → src/libserialport/private/common.nim b/src/serialport/private/common.nim → src/libserialport/private/common.nim
diff --git a/src/serialport/private/list_serialports.nim → ...ibserialport/private/list_serialports.nim b/src/serialport/private/list_serialports.nim → ...ibserialport/private/list_serialports.nim
diff --git a/...alport/private/list_serialports/linux.nim → ...alport/private/list_serialports/linux.nim b/...alport/private/list_serialports/linux.nim → ...alport/private/list_serialports/linux.nim
diff --git a/...rialport/private/list_serialports/mac.nim → ...rialport/private/list_serialports/mac.nim b/...rialport/private/list_serialports/mac.nim → ...rialport/private/list_serialports/mac.nim
diff --git a/...alport/private/list_serialports/posix.nim → ...alport/private/list_serialports/posix.nim b/...alport/private/list_serialports/posix.nim → ...alport/private/list_serialports/posix.nim
diff --git a/...port/private/list_serialports/windows.nim → ...port/private/list_serialports/windows.nim b/...port/private/list_serialports/windows.nim → ...port/private/list_serialports/windows.nim
diff --git a/src/serialport/private/serial_posix.nim → src/libserialport/private/serial_posix.nim b/src/serialport/private/serial_posix.nim → src/libserialport/private/serial_posix.nim
diff --git a/src/serialport/private/serial_windows.nim → src/libserialport/private/serial_windows.nim b/src/serialport/private/serial_windows.nim → src/libserialport/private/serial_windows.nim